Kanzi 4.0.0-beta2
kanzi::gfx::CopyBufferCommand Struct Reference

Copies a region of a source buffer to a destination buffer. More...

#include <kanzi/gfx/commands.hpp>

Inheritance diagram for kanzi::gfx::CopyBufferCommand:
[legend]

Public Member Functions

 CopyBufferCommand ()
 Constructor.
 
- Public Member Functions inherited from kanzi::gfx::BaseCommand
uint32_t getSize () const
 Gets the command size in bytes.
 
uint8_t getTag () const
 Gets the command tag.
 
CommandType getType () const
 Gets the command type.
 
void setTag (uint8_t tag)
 Sets the command tag.
 

Public Attributes

BufferHandleGuard destinationBuffer
 The destination buffer. Must have BufferUsageFlag::CopyDestination.
 
uint32_t destinationOffset
 The destination offset in bytes.
 
uint32_t size
 The size of bytes to copy in bytes.
 
BufferHandleGuard sourceBuffer
 The source buffer. Must have BufferUsageFlag::CopySource.
 
uint32_t sourceOffset
 The source offset in bytes.
 

Additional Inherited Members

- Protected Member Functions inherited from kanzi::gfx::BaseCommand
 BaseCommand (CommandType t, uint32_t s)
 Constructor.
 
 BaseCommand (const BaseCommand &other)
 Copy Constructor.
 
BaseCommandoperator= (const BaseCommand &other)
 Assignment operator.
 

Detailed Description

Copies a region of a source buffer to a destination buffer.

Since
Kanzi 4.0.0

Constructor & Destructor Documentation

◆ CopyBufferCommand()

kanzi::gfx::CopyBufferCommand::CopyBufferCommand ( )
inline

Constructor.

Member Data Documentation

◆ sourceBuffer

BufferHandleGuard kanzi::gfx::CopyBufferCommand::sourceBuffer

The source buffer. Must have BufferUsageFlag::CopySource.

◆ destinationBuffer

BufferHandleGuard kanzi::gfx::CopyBufferCommand::destinationBuffer

The destination buffer. Must have BufferUsageFlag::CopyDestination.

◆ sourceOffset

uint32_t kanzi::gfx::CopyBufferCommand::sourceOffset

The source offset in bytes.

◆ destinationOffset

uint32_t kanzi::gfx::CopyBufferCommand::destinationOffset

The destination offset in bytes.

◆ size

uint32_t kanzi::gfx::CopyBufferCommand::size

The size of bytes to copy in bytes.

When the maximum value is specified, the size represents the rest of the source buffer.


The documentation for this struct was generated from the following file: